SearchAccountsBySerialNumber

The SearchAccountsBySerialNumber web service XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. allows external applications to search for Accounts using Account In the Cloud Monetisation Platform, a billing entity that can be used to manage payments on one or more subscriptions or payments for services. An account can hold details such as payments or invoices. Serial Numbers. It accepts an Account Serial Number and an optional Account Serial Status to help narrow or widen the search.

SearchAccountsBySerialNumber Request

The SearchAccountsBySerialNumber tag instructs the Search Service to search for an Account using an Account Serial Number. This request contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	The client may use this identifier to correlate the request and the response.	Optional
AccountSerialNumber	String25	The Account Serial Number to search for an Account with.	Mandatory
SerialStatus	String	Search for the status specified. Can be used to refine or widen the scope of the search. If not supplied then all statuses are searched. Possible values: ALL CURRENT	Optional

SearchAccountsBySerialNumber Response

The SearchAccountsBySerialNumber response is the response to the SearchAccountsBySerialNumber request. This contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	Returned unmodified in the response. The client may use this identifier to correlate the request and the response.	Optional
SearchAccountResults	Container	Contains zero or more SearchAccountResult response containers. See SearchAccountResult response container for details.	Mandatory
QueryLimitExceeded	Boolean	Set to True if the maximum number of records that may be returned as defined in the configuration, was exceeded.	Mandatory

This web service uses a CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. back office configurable Query Limit parameter that contains the maximum number of Account Numbers to return. If the search finds more records than the query limit then the number of Account Numbers actually returned in the response is equal to the Query Limit and the Query Limit Exceeded flag is set to True. The Query Limit is configured as part of the standard CMP Web Service configuration.

SearchAccountsResults Response Container

The SearchAccountsResults response container contains the following elements:

Element Name	Content Type	Description	Required?
SearchAccountsResult	Container	See SearchAccountsResult response container for details.	Optional

SearchAccountsResult Response Container

The SearchAccountsResult response container contains the following elements:

Element Name	Content Type	Description	Required?
AccountNumber	Integer8	The account number automatically allocated upon account creation in CMP.	Mandatory
AccountSerialNumber	String25	The Account Serial Number used to search with.	Mandatory
SerialNumberStatus	String	Possible values: CURRENT SUPERSEDED.	Mandatory
AccountSerialNumberId	Integer3	This displays Account Serial Numbers held against an Account.	Mandatory
AddressNumber	Integer8	The CMP address number for the Subscriber.	Optional
CorporateCode	String6	The unique ID allocated to the Corporate by the CMP, if appropriate.	Optional
GroupCode	String6	The unique ID allocated to the Group by the CMP, if appropriate.	Optional
AccountType	String3	Indicates the Account Type the Subscription belongs to, e.g. VIP Account.	Optional
AccountUsage	String - Enumeration	Possible values: Subscription Sales SubscriptionAndSales	Optional

It is possible for the same Account Number to be returned multiple times when Account Serial Numbers exist multiple times against an Account.